charger28.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2026 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/

 
#ifndef CHARGER28_H
#define CHARGER28_H
 
#ifdef __cplusplus
extern "C"{
#endif

#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"




#define CHARGER28_REG_CHARGE_CURRENT_LIMIT                  0x02
#define CHARGER28_REG_CHARGE_VOLTAGE_LIMIT                  0x04
#define CHARGER28_REG_INPUT_CURRENT_LIMIT                   0x06
#define CHARGER28_REG_INPUT_VOLTAGE_LIMIT                   0x08
#define CHARGER28_REG_IOTG_REGULATION                       0x0A
#define CHARGER28_REG_VOTG_REGULATION                       0x0C
#define CHARGER28_REG_MINIMAL_SYSTEM_VOLTAGE                0x0E
#define CHARGER28_REG_PRECHARGE_CONTROL                     0x10
#define CHARGER28_REG_TERMINATION_CONTROL                   0x12
#define CHARGER28_REG_CHARGE_TIMER_CONTROL                  0x14
#define CHARGER28_REG_CHARGER_CONTROL_0                     0x15
#define CHARGER28_REG_CHARGER_CONTROL_1                     0x16
#define CHARGER28_REG_CHARGER_CONTROL_2                     0x17
#define CHARGER28_REG_CHARGER_CONTROL_3                     0x18
#define CHARGER28_REG_CHARGER_CONTROL_4                     0x19
#define CHARGER28_REG_CHARGER_CONTROL_5                     0x1A
#define CHARGER28_REG_NTC_CONTROL_0                         0x1C
#define CHARGER28_REG_NTC_CONTROL_1                         0x1D
#define CHARGER28_REG_NTC_CONTROL_2                         0x1E
#define CHARGER28_REG_NTC_CONTROL_3                         0x1F
#define CHARGER28_REG_CHARGER_STATUS_0                      0x20
#define CHARGER28_REG_CHARGER_STATUS_1                      0x21
#define CHARGER28_REG_FAULT_STATUS                          0x22
#define CHARGER28_REG_CHARGER_FLAG_0                        0x23
#define CHARGER28_REG_CHARGER_FLAG_1                        0x24
#define CHARGER28_REG_FAULT_FLAG                            0x25
#define CHARGER28_REG_CHARGER_MASK_0                        0x26
#define CHARGER28_REG_CHARGER_MASK_1                        0x27
#define CHARGER28_REG_FAULT_MASK                            0x28
#define CHARGER28_REG_ICO_CURRENT_LIMIT                     0x29
#define CHARGER28_REG_ADC_CONTROL                           0x2B
#define CHARGER28_REG_ADC_CHANNEL_DISABLE                   0x2C
#define CHARGER28_REG_IBUS_ADC                              0x2D
#define CHARGER28_REG_IBAT_ADC                              0x2F
#define CHARGER28_REG_VBUS_ADC                              0x31
#define CHARGER28_REG_VPMID_ADC                             0x33
#define CHARGER28_REG_VBAT_ADC                              0x35
#define CHARGER28_REG_VSYS_ADC                              0x37
#define CHARGER28_REG_TS_ADC                                0x39
#define CHARGER28_REG_TDIE_ADC                              0x3B
#define CHARGER28_REG_ADCIN_ADC                             0x3D
#define CHARGER28_REG_PART_INFORMATION                      0x3F
#define CHARGER28_REG_VIRTUAL_CONTROL_0                     0x80
#define CHARGER28_REG_VIRTUAL_CONTROL_1                     0x81
 // charger28_reg



#define CHARGER28_CHARGER_CONTROL_1_EN_AUTO_IBAT_DSCHG_DIS  0x00
#define CHARGER28_CHARGER_CONTROL_1_EN_AUTO_IBAT_DSCHG_EN   0x80
#define CHARGER28_CHARGER_CONTROL_1_EN_AUTO_IBAT_DSCHG_MASK 0x80
#define CHARGER28_CHARGER_CONTROL_1_FORCE_IBAT_DSCHG_DIS    0x00
#define CHARGER28_CHARGER_CONTROL_1_FORCE_IBAT_DSCHG_EN     0x40
#define CHARGER28_CHARGER_CONTROL_1_FORCE_IBAT_DSCHG_MASK   0x40
#define CHARGER28_CHARGER_CONTROL_1_EN_CHG_DIS              0x00
#define CHARGER28_CHARGER_CONTROL_1_EN_CHG_EN               0x20
#define CHARGER28_CHARGER_CONTROL_1_EN_CHG_MASK             0x20
#define CHARGER28_CHARGER_CONTROL_1_EN_HIZ_DIS              0x00
#define CHARGER28_CHARGER_CONTROL_1_EN_HIZ_EN               0x10
#define CHARGER28_CHARGER_CONTROL_1_EN_HIZ_MASK             0x10
#define CHARGER28_CHARGER_CONTROL_1_FORCE_PMID_DSCHG_DIS    0x00
#define CHARGER28_CHARGER_CONTROL_1_FORCE_PMID_DSCHG_EN     0x08
#define CHARGER28_CHARGER_CONTROL_1_FORCE_PMID_DSCHG_MASK   0x08
#define CHARGER28_CHARGER_CONTROL_1_WD_RST_CLEAR            0x00
#define CHARGER28_CHARGER_CONTROL_1_WD_RST_SET              0x04
#define CHARGER28_CHARGER_CONTROL_1_WD_RST_MASK             0x04
#define CHARGER28_CHARGER_CONTROL_1_WATCHDOG_DISABLE        0x00
#define CHARGER28_CHARGER_CONTROL_1_WATCHDOG_40S            0x01
#define CHARGER28_CHARGER_CONTROL_1_WATCHDOG_80S            0x02
#define CHARGER28_CHARGER_CONTROL_1_WATCHDOG_160S           0x03
#define CHARGER28_CHARGER_CONTROL_1_WATCHDOG_MASK           0x03

#define CHARGER28_CHARGER_CONTROL_2_REG_RST_CLEAR           0x00
#define CHARGER28_CHARGER_CONTROL_2_REG_RST_SET             0x80
#define CHARGER28_CHARGER_CONTROL_2_REG_RST_MASK            0x80
#define CHARGER28_CHARGER_CONTROL_2_TREG_60C                0x00
#define CHARGER28_CHARGER_CONTROL_2_TREG_120C               0x40
#define CHARGER28_CHARGER_CONTROL_2_TREG_MASK               0x40
#define CHARGER28_CHARGER_CONTROL_2_EN_DITHER_DISABLE       0x00
#define CHARGER28_CHARGER_CONTROL_2_EN_DITHER_1X            0x10
#define CHARGER28_CHARGER_CONTROL_2_EN_DITHER_2X            0x20
#define CHARGER28_CHARGER_CONTROL_2_EN_DITHER_3X            0x30
#define CHARGER28_CHARGER_CONTROL_2_EN_DITHER_MASK          0x30
#define CHARGER28_CHARGER_CONTROL_2_SET_CONV_STRN_RED_3     0x00
#define CHARGER28_CHARGER_CONTROL_2_SET_CONV_STRN_RED_2     0x04
#define CHARGER28_CHARGER_CONTROL_2_SET_CONV_STRN_RED_1     0x08
#define CHARGER28_CHARGER_CONTROL_2_SET_CONV_STRN_MAX       0x0C
#define CHARGER28_CHARGER_CONTROL_2_SET_CONV_STRN_MASK      0x0C
#define CHARGER28_CHARGER_CONTROL_2_SET_BATFET_STRN_RED     0x00
#define CHARGER28_CHARGER_CONTROL_2_SET_BATFET_STRN_MAX     0x02
#define CHARGER28_CHARGER_CONTROL_2_SET_BATFET_STRN_MASK    0x02
#define CHARGER28_CHARGER_CONTROL_2_VBUS_OVP_6_3V           0x00
#define CHARGER28_CHARGER_CONTROL_2_VBUS_OVP_18_5V          0x01
#define CHARGER28_CHARGER_CONTROL_2_VBUS_OVP_MASK           0x01

#define CHARGER28_NTC_CONTROL_0_TS_IGNORE_CLEAR             0x00
#define CHARGER28_NTC_CONTROL_0_TS_IGNORE_SET               0x80
#define CHARGER28_NTC_CONTROL_0_TS_IGNORE_MASK              0x80
#define CHARGER28_NTC_CONTROL_0_CHG_RATE_1C                 0x00
#define CHARGER28_NTC_CONTROL_0_CHG_RATE_2C                 0x20
#define CHARGER28_NTC_CONTROL_0_CHG_RATE_4C                 0x40
#define CHARGER28_NTC_CONTROL_0_CHG_RATE_6C                 0x60
#define CHARGER28_NTC_CONTROL_0_CHG_RATE_MASK               0x60
#define CHARGER28_NTC_CONTROL_0_TS_TH_OTG_HOT_55C           0x00
#define CHARGER28_NTC_CONTROL_0_TS_TH_OTG_HOT_60C           0x08
#define CHARGER28_NTC_CONTROL_0_TS_TH_OTG_HOT_65C           0x10
#define CHARGER28_NTC_CONTROL_0_TS_TH_OTG_HOT_DISABLE       0x18
#define CHARGER28_NTC_CONTROL_0_TS_TH_OTG_HOT_MASK          0x18
#define CHARGER28_NTC_CONTROL_0_TS_TH_OTG_COLD_MIN_10C      0x00
#define CHARGER28_NTC_CONTROL_0_TS_TH_OTG_COLD_MIN_20C      0x04
#define CHARGER28_NTC_CONTROL_0_TS_TH_OTG_COLD_MASK         0x04
#define CHARGER28_NTC_CONTROL_0_TS_TH1_MIN_5C               0x00
#define CHARGER28_NTC_CONTROL_0_TS_TH1_0C                   0x02
#define CHARGER28_NTC_CONTROL_0_TS_TH1_MASK                 0x02
#define CHARGER28_NTC_CONTROL_0_TS_TH6_55C                  0x00
#define CHARGER28_NTC_CONTROL_0_TS_TH6_60C                  0x01
#define CHARGER28_NTC_CONTROL_0_TS_TH6_MASK                 0x01

#define CHARGER28_CHARGER_STATUS_0_PG_STAT                  0x80
#define CHARGER28_CHARGER_STATUS_0_ADC_DONE_STAT            0x40
#define CHARGER28_CHARGER_STATUS_0_TREG_STAT                0x20
#define CHARGER28_CHARGER_STATUS_0_VSYS_STAT                0x10
#define CHARGER28_CHARGER_STATUS_0_IINDPM_STAT              0x08
#define CHARGER28_CHARGER_STATUS_0_VINDPM_STAT              0x04
#define CHARGER28_CHARGER_STATUS_0_SAFETY_TMR_STAT          0x02
#define CHARGER28_CHARGER_STATUS_0_WD_STAT                  0x01

#define CHARGER28_CHARGER_STATUS_1_ICO_STAT_DIS             0x00
#define CHARGER28_CHARGER_STATUS_1_ICO_STAT_OPTIMIZATION    0x40
#define CHARGER28_CHARGER_STATUS_1_ICO_STAT_MAX_IN_CURRENT  0x80
#define CHARGER28_CHARGER_STATUS_1_ICO_STAT_SUSPENDED       0xC0
#define CHARGER28_CHARGER_STATUS_1_ICO_STAT_MASK            0xC0
#define CHARGER28_CHARGER_STATUS_1_CHG_STAT_NOT_CHARGING    0x00
#define CHARGER28_CHARGER_STATUS_1_CHG_STAT_TRICKLE_CHARGE  0x08
#define CHARGER28_CHARGER_STATUS_1_CHG_STAT_PRE_CHARGE      0x10
#define CHARGER28_CHARGER_STATUS_1_CHG_STAT_FAST_CHARGE     0x18
#define CHARGER28_CHARGER_STATUS_1_CHG_STAT_TAPER_CHARGE    0x20
#define CHARGER28_CHARGER_STATUS_1_CHG_STAT_TO_TIMER_ACT_CH 0x30
#define CHARGER28_CHARGER_STATUS_1_CHG_STAT_CHARGE_DONE     0x38
#define CHARGER28_CHARGER_STATUS_1_CHG_STAT_MASK            0x38
#define CHARGER28_CHARGER_STATUS_1_VBUS_STAT_NOT_POWERED    0x00
#define CHARGER28_CHARGER_STATUS_1_VBUS_STAT_IINDPM         0x04
#define CHARGER28_CHARGER_STATUS_1_VBUS_STAT_IN_BOOST_OTG   0x07
#define CHARGER28_CHARGER_STATUS_1_VBUS_STAT_MASK           0x07

#define CHARGER28_FAULT_STATUS_VBUS_FAULT_STAT              0x80
#define CHARGER28_FAULT_STATUS_BAT_FAULT_STAT               0x40
#define CHARGER28_FAULT_STATUS_VSYS_FAULT_STAT              0x20
#define CHARGER28_FAULT_STATUS_OTG_FAULT_STAT               0x10
#define CHARGER28_FAULT_STATUS_TSHUT_STAT                   0x08
#define CHARGER28_FAULT_STATUS_TS_STAT_TS_NORMAL            0x00
#define CHARGER28_FAULT_STATUS_TS_STAT_TS_COLD              0x01
#define CHARGER28_FAULT_STATUS_TS_STAT_TS_HOT               0x02
#define CHARGER28_FAULT_STATUS_TS_STAT_TS_COOL              0x03
#define CHARGER28_FAULT_STATUS_TS_STAT_TS_WARM              0x04
#define CHARGER28_FAULT_STATUS_TS_STAT_TS_PRECOOL           0x05
#define CHARGER28_FAULT_STATUS_TS_STAT_TS_PREWARM           0x06
#define CHARGER28_FAULT_STATUS_TS_STAT_MASK                 0x07

#define CHARGER28_ADC_CONTROL_EN_ADC_DIS                    0x00
#define CHARGER28_ADC_CONTROL_EN_ADC_EN                     0x80
#define CHARGER28_ADC_CONTROL_EN_ADC_MASK                   0x80
#define CHARGER28_ADC_CONTROL_ADC_RATE_CONTINUOUS           0x00
#define CHARGER28_ADC_CONTROL_ADC_RATE_ONE_SHOT             0x40
#define CHARGER28_ADC_CONTROL_ADC_RATE_MASK                 0x40
#define CHARGER28_ADC_CONTROL_ADC_SAMPLE_11BIT              0x00
#define CHARGER28_ADC_CONTROL_ADC_SAMPLE_10BIT              0x10
#define CHARGER28_ADC_CONTROL_ADC_SAMPLE_9BIT               0x20
#define CHARGER28_ADC_CONTROL_ADC_SAMPLE_8BIT               0x30
#define CHARGER28_ADC_CONTROL_ADC_SAMPLE_MASK               0x30
#define CHARGER28_ADC_CONTROL_ADC_AVG_DIS                   0x00
#define CHARGER28_ADC_CONTROL_ADC_AVG_EN                    0x08
#define CHARGER28_ADC_CONTROL_ADC_AVG_MASK                  0x08
#define CHARGER28_ADC_CONTROL_ADC_AVG_INIT_REG_VALUE        0x00
#define CHARGER28_ADC_CONTROL_ADC_AVG_INIT_NEW_CONV         0x04
#define CHARGER28_ADC_CONTROL_ADC_AVG_INIT_MASK             0x04
#define CHARGER28_ADC_CONTROL_DIS_ADCIN_ADC_EN              0x00
#define CHARGER28_ADC_CONTROL_DIS_ADCIN_ADC_DIS             0x01
#define CHARGER28_ADC_CONTROL_DIS_ADCIN_ADC_MASK            0x01

#define CHARGER28_LSB_ADC_IBUS                              2.5
#define CHARGER28_LSB_ADC_VBUS                              5
#define CHARGER28_LSB_ADC_VPMID                             5
#define CHARGER28_LSB_ADC_VBAT                              1.25
#define CHARGER28_LSB_ADC_IBAT                              5
#define CHARGER28_LSB_ADC_VSYS                              1.25
#define CHARGER28_LSB_ADC_ADCIN                             0.25
#define CHARGER28_LSB_ADC_TS                                0.098
#define CHARGER28_LSB_ADC_TDIE                              0.5

#define CHARGER28_PART_NUMBER                               0x04
#define CHARGER28_PART_NUMBER_MASK                          0x3C

#define CHARGER28_DEVICE_ADDRESS                            0x6B
 // charger28_set



#define CHARGER28_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.pg = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.cen = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.sts = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 // charger28_map // charger28

typedef struct
{
    // Output pins
    digital_out_t cen;              
 
    // Input pins
    digital_in_t pg;                
    digital_in_t sts;               
    digital_in_t int_pin;           
 
    // Modules
    i2c_master_t i2c;               
 
    // I2C slave address
    uint8_t slave_address;          
 
} charger28_t;

typedef struct
{
    pin_name_t scl;                 
    pin_name_t sda;                 
 
    pin_name_t pg;                  
    pin_name_t cen;                 
    pin_name_t sts;                 
    pin_name_t int_pin;             
 
    uint32_t   i2c_speed;           
    uint8_t    i2c_address;         
 
} charger28_cfg_t;

typedef enum
{
    CHARGER28_OK = 0,
    CHARGER28_ERROR = -1
 
} charger28_return_value_t;


void charger28_cfg_setup ( charger28_cfg_t *cfg );

err_t charger28_init ( charger28_t *ctx, charger28_cfg_t *cfg );

err_t charger28_default_cfg ( charger28_t *ctx );

err_t charger28_write_reg_bytes ( charger28_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );

err_t charger28_read_reg_bytes ( charger28_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );

err_t charger28_write_reg_byte ( charger28_t *ctx, uint8_t reg, uint8_t data_in );

err_t charger28_read_reg_byte ( charger28_t *ctx, uint8_t reg, uint8_t *data_out );

err_t charger28_write_reg_word ( charger28_t *ctx, uint8_t reg, uint16_t data_in );

err_t charger28_read_reg_word ( charger28_t *ctx, uint8_t reg, uint16_t *data_out );

err_t charger28_check_communication ( charger28_t *ctx );

void charger28_enable_charging ( charger28_t *ctx );

void charger28_disable_charging ( charger28_t *ctx );

uint8_t charger28_get_pg_pin ( charger28_t *ctx );

uint8_t charger28_get_sts_pin ( charger28_t *ctx );

uint8_t charger28_get_int_pin ( charger28_t *ctx );

err_t charger28_get_ibus ( charger28_t *ctx, float *ibus );

err_t charger28_get_ibat ( charger28_t *ctx, int16_t *ibat );

err_t charger28_get_vbus ( charger28_t *ctx, uint16_t *vbus );

err_t charger28_get_vpmid ( charger28_t *ctx, uint16_t *vpmid );

err_t charger28_get_vbat ( charger28_t *ctx, float *vbat );

err_t charger28_get_vsys ( charger28_t *ctx, float *vsys );

err_t charger28_get_ts ( charger28_t *ctx, float *ts );

err_t charger28_get_tdie ( charger28_t *ctx, float *tdie );

err_t charger28_get_adcin ( charger28_t *ctx, float *adcin );
 
#ifdef __cplusplus
}
#endif
#endif // CHARGER28_H
 // charger28
 
// ------------------------------------------------------------------------ END